/*
 * Licensed to the http://code.google.com/p/crunchutils under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.crunchutils;

import java.io.File;
import java.util.Comparator;

/**
 * This comparator helps to sort a collection of files by their last modified date so that the
 * recently modified file appears at the top of the collection
 * @author James Selvakumar
 */
public class FileLastModifiedComparator implements Comparator<File>
{
    /**
     * Compares the last modified date of two files for order. Returns a negative integer, zero, or a positive integer as the
     * second argument is less than, equal to, or greater than the first.
     */
    @Override
    public int compare(File file1, File file2)
    {
        if (file2.lastModified() < file1.lastModified()) {
            return -1;
        } else if (file2.lastModified() == file1.lastModified()) {
            return 0;
        } else {
            return 1;
        }
    }
}
